home *** CD-ROM | disk | FTP | other *** search
/ Shareware Games Galore! / Shareware Games Galore!.iso / arcade / nirvana / nirvtech.doc < prev    next >
Encoding:
Text File  |  1989-04-06  |  15.4 KB  |  456 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. NIRVANA TECHNICAL INFORMATION FOR SYSOPS
  9.  
  10. Wimsey Co. presents NIRVANA 3.1, with door interface for PCBoard v. 11.8 thru
  11. 14, adaptable to other boards.  Discard older versions.  The differences among
  12. versions 3.0 through 3.1 relate to the operation of the door program.
  13.  
  14. Nirvana is a premium BBS door program.  It is very easy to install on most BBS
  15. systems.  There is NO CHARGE required to run the door version, but YOU MUST
  16. REGISTER your copy of Nirvana for use on your BBS.
  17.  
  18. This file provides information to BBS Sysops for registering and setting up the
  19. Nirvana program as a BBS online game door.
  20.  
  21.  
  22. THE LEGALESE
  23.  
  24. NIRVANA 3.1, Copyright (c) 1989 by Wimsey Co.  You may copy and use this
  25. product and documentation complete and without modification, provided that:
  26.  
  27. (a) if you run NIRVANA offline, you must register your copy by sending $2.00 to
  28.     Wimsey Co. with your name and address;
  29.  
  30. (b) if you run NIRVANA online, you must register by mail or online telling
  31.     Wimsey Co. the version of NIRVANA, along with your name, the name and phone
  32.     number of your BBS or business, your BBS software type and version number,
  33.     and your mailing address (unless you ask us not to, we make this
  34.     information public); and you must display at least the first sentence of
  35.     the file BULLETIN.1 online as a news item or bulletin until the First
  36.     Wimsey Contest is over, and make the Nirvana archive file freely available
  37.     for download by your users.
  38.  
  39. All other rights are reserved.  See NIRVANA.DOC for disclaimer of liability.
  40.  
  41. A gentle reminder to those who fail to register: you are subjecting yourself to
  42. legal liability.  Willful violations of the Copyright Law of the United States
  43. can result in civil damages of $50,000.00 plus actual damages, and criminal
  44. penalties.  It's the law.  Thank you for registering.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.     List of files:
  53.  
  54. NIRVANA.EXE    NIRV.D1      NIRV.D3       NIRVANA.DOC  (Player manual)
  55. NIRVXTR.EXE    NIRV.D2      NIRV.D4       NIRVTECH.DOC (This document)
  56. README.1ST     BULLETIN.n
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. 1
  67.  
  68.  
  69.  
  70.  
  71. REGULAR FEATURES OF NIRVANA DOOR
  72.  
  73.   - Easy to install.  Runs on PCBoard, RBBS, Opus, TBBS, Wildcat, WWIV, QBBS,
  74.     NOCHANGE, Auntie, GT PowerComm, Asgard, and other BBS software worldwide.
  75.  
  76.   - Optional SAVE feature allows users to save a game position.  This option is
  77.     available to sysops with PCBOARD.SYS file who register for the save feature
  78.     (see REG below).
  79.  
  80.   - Creates a Top 10 Players bulletin, if you have a PCBOARD.SYS file.
  81.  
  82.   - Does not drop carrier, and terminates cleanly through exit code, so your
  83.     BBS software can log off user.
  84.  
  85.   - A commercial message that appears in offline mode does not appear when you
  86.     run Nirvana on your BBS system.
  87.  
  88.   - Runs in most multi-tasking and network environments including DoubleDOS
  89.     two node operation, LANtastic, and with US Robotics Courier HST 9600 baud
  90.     modem when properly configured.  (See notes to multi-node users and to
  91.     high speed modem users.)
  92.  
  93.  
  94. SPECIAL FEATURES OF NIRVANA DOOR
  95.  
  96. If you designate COM1 or COM2 in the configuration file, the following special
  97. features are also in effect.  (If you don't designate COM1 or COM2 you may use
  98. a redirection method such as DOORWAY, described below.)
  99.  
  100.   - Sysop function keys to return to the board, toggle screen on and off, and
  101.     for chat mode:
  102.  
  103.      <Home> This key displays a status line on the local screen.  (If you do
  104.             not use DOS SCREEN, the status line always appears on line 1 and
  105.             Home has no effect.)
  106.  
  107.       F8    Terminates the program, returning control to the board.
  108.  
  109.       F9    Toggles the local screen on and off.
  110.  
  111.      F10    Chat mode.  (Escape to exit chat mode)
  112.  
  113.   - Detects lost carrier, operates at 8N1 or 7E1, ignores Control-C from modem.
  114.  
  115.   - Supports interrupt driven com port I/O.
  116.  
  117.   - Carrier must be present.  Does NOT operate in local mode.
  118.  
  119.   - Gives warnings and terminates if keyboard is inactive and when time is up
  120.     (bell is not sounded locally).
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132. 2
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139. To install NIRVANA you will need to write a BATCH FILE and a CONFIGURATION
  140. FILE, as described below:
  141.  
  142.  
  143. BATCH FILE SETUP
  144.  
  145. Create a batch file to invoke the program.  Suggested setups:
  146.  
  147. For a Single Node      For Multiple Nodes
  148.                        Node 1
  149. NIRV.BAT               NIRV1.BAT
  150. --------------------   -------------------
  151. CD C:\NIRVANA          CD C:\NIRVANA         {change to NIRVANA directory}
  152. NIRVANA.EXE NIRV.CFG   NIRVANA NIRV1.CFG     {invoke NIRVANA}
  153. CD C:\PCB              CD C:\PCB1            {your board's main directory}
  154. BOARD.BAT              BOARD1.BAT            {return to the board}
  155. --------------------   -------------------
  156.  
  157. For PCBoard:
  158.  
  159.   - Put the NIRV batch file in the \PCB directory, and leave off the .BAT file
  160.     extension.
  161.  
  162.   - Run PCBSETUP's File Name option and designate a DOOR's Data File called
  163.     DOORS.DAT.
  164.  
  165.   - Run PCBSM or PCBSETUP and edit the Doors Listing (DOORS.DAT) to include a
  166.     line in the form <door batch file name>, <password>, <security level>.  If
  167.     the optional password is omitted, the command "type doors.dat" shows an
  168.     entry in the form:
  169.  
  170.              NIRVANA,,20
  171.  
  172.   - The DOORS.DAT file for each applicable conference needs an entry.
  173.  
  174.   - If your DOORS.DAT is shared between nodes, you can call each batch file
  175.     NIRV, but place a different NIRV in the "\PCBn" subdirectory for each node.
  176.  
  177.  
  178. For non-PCBoard:
  179.  
  180.   - Nirvana works fine without a PCBOARD.SYS file.  However, this file is
  181.     needed for the scoreboard and save the game features to operate.
  182.  
  183.   - Programs exist to create a PCBOARD.SYS file for a variety of BBS types.
  184.     If possible, use such a program and set up the configuration as if you ran
  185.     PCBoard.
  186.  
  187.   - The scoreboard bulletin function takes the user name from PCBOARD.SYS.
  188.  
  189.   - The SAVE function takes the user record number from PCBOARD.SYS.  This
  190.     works best when a different and consistent user record number is supplied
  191.     for each user.  Otherwise, you could tell users that SAVE works for the
  192.     current session only and add add the following line to your NIRV.BAT file:
  193.  
  194.              IF EXIST N-*.SAV DEL N-*.SAV
  195.  
  196.  
  197.  
  198. 3
  199.  
  200.  
  201.  
  202.  
  203.  
  204. CONFIG FILE SETUP (ENTRIES CAN BE IN ANY ORDER)
  205.  
  206. Make a \NIRVANA directory containing the distribution NIRVANA files and a text
  207. file called NIRV.CFG.  (Multi-node users see NOTES FOR MULTI-NODE USERS on last
  208. page.)
  209.  
  210. The following examples document the configuration file setup.  Each entry can
  211. go in ANY ORDER, but must be on a separate line.  Each entry is more fully
  212. described later.
  213.  
  214.  
  215. NIRV.CFG file for users with a PCBOARD.SYS file on C\:PCB:
  216. ---------------------------
  217. BBS=<Your BBS's Name>       {registered BBS Name shows up on initial screen;
  218.                              this entry is required}
  219. COM1                        {select COM1 or COM2}
  220. PCB14SYS=C:\PCB\PCBOARD.SYS {path of PCBOARD.SYS file, version 14}
  221.  { or }
  222. PCB12SYS=C:\PCB\PCBOARD.SYS {path of PCBOARD.SYS file, versions 11.8 thru 12.1}
  223. TOP10=C:\PCB\GEN\BLT7       {location of Bulletin file "Top 10 Players"}
  224. SAVE                        {option allows player to save and restore a game
  225.                              position, when you register online on our BBS}
  226. REG=00000                   {Registration number, needed for SAVE to work}
  227. ---------------------------
  228.  
  229.  
  230. Options for multi-node PCBoard: (See NOTES FOR MULTI-NODE USERS on last page.)
  231. ---------------------------
  232. SCORE=E:\NIRVANA\SCORE.DTA  {one file for all multi-node scores data}
  233. SAVE=E:\NIRVANA\            {one directory for all multi-node save files}
  234. ---------------------------
  235.  
  236.  
  237. NIRV.CFG for non-PCBoard:
  238. ---------------------------
  239. BBS=<Your BBS's Name>       {registered BBS Name shows up on initial screen;
  240.                              this entry is required}
  241. COM1                        {select COM1 or COM2}
  242. MINLEFT=60                  {caller time remaining, if no PCBOARD.SYS file}
  243. ---------------------------
  244.  
  245.  
  246. Options for both PCBoard and non-PCBoard:
  247. ---------------------------
  248. BIOS MODEM                  {selects BIOS calls for modem I/O}
  249. DOS SCREEN                  {all local I/O via DOS calls, for multi-tasking
  250.                              and allows I/O redirection as described below}
  251. NUL SCREEN                  {screen off till toggled, for multi-tasking,
  252.                              add this after the door is working}
  253. ---------------------------
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. 4
  265.  
  266.  
  267.  
  268.  
  269. DESCRIPTION OF CONFIG FILE ENTRIES:
  270.  
  271.  
  272. BBS=Your BBS Name
  273.  
  274. When you have mailed your sysop registration postcard or registered online, you
  275. may insert your registered BBS name here and it will show up on the initial
  276. screen.  You must insert a name containing at least six characters and spaces
  277. for the program to run online.
  278.  
  279.  
  280. COM1 or COM2
  281.  
  282. You must designate a Com port for the special features to work (except for
  283. DOS SCREEN, which can work by itself to enable redirection of I/O as described
  284. later.)
  285.  
  286.  
  287. PCB14SYS=C:\PCB\PCBOARD.SYS or PCB12SYS=C:\PCB\PCBOARD.SYS
  288.  
  289. The program gets the user name and user record number and time left from the
  290. PCBoard.SYS file.
  291.  
  292. Use PCB14SYS= for version 14 and PCB12SYS= for PCBoard versions 11.8 thru 12.1.
  293. After the =, show the full path and name of your PCBoard.SYS file.
  294.  
  295.  
  296. TOP10=[<drive:>]<pathname>
  297.  
  298. If you designate a PCBOARD.SYS file, a one-screen "SCOREBOARD" bulletin file
  299. will automatically be maintained.  You may optionally designate the path and
  300. file name by a config entry such as TOP10=C:\PCB\GEN\BLT7, so this bulletin can
  301. be accessed from a BBS bulletin menu.  This file may be deleted and will
  302. automatically be re-created during play.
  303.  
  304. Note:
  305.     If your BBS reads bulletins from a RAM disk, then designate the RAM disk in
  306.     the config file, but also place the following entry in the batch file which
  307.     initializes your RAM disk.  This will create a current bulletin when your
  308.     RAM disk is created:  (Spaces are significant separators.)
  309.  
  310.     [<drive:>][<path>]NIRVANA.EXE TOP10=[<drive:>]<path> SCORE=[<drive:><path>
  311.     E.G. C:\NIRVANA\NIRVANA.EXE TOP10=D:\BLT7 SCORE=E:\NIRVANA\SCORE.DTA
  312.  
  313.  
  314. SAVE
  315.  
  316. This optional feature enables the user to save a game position.  It is
  317. available without charge to sysops who register online (see REG below), and who
  318. have a PCBOARD.SYS file.  The program saves one game position per player in a
  319. separate 4 K file under the name N-nnnnn.SAV, where nnnnn is the user record
  320. number as read from PCBOARD.SYS.  These save files would need to be deleted or
  321. renamed if your BBS user file is packed or sorted.  Verify installation of this
  322. feature by entering 'save' at the '>' game prompt.
  323.  
  324.  
  325. REG=nnnnn
  326.  
  327. Sysops can register without charge to receive a registration number that
  328. enables the SAVE the game feature.  See SYSOP REGISTRATION below.
  329.  
  330. 5
  331.  
  332.  
  333.  
  334. SCORE=[<drive:>]<pathname>
  335.  
  336. If you designate a PCBOARD.SYS file, an internal score data file will be
  337. maintained.  You may optionally designate the path and file name by a config
  338. entry such as SCORE=E:\NIRVANA\SCORE.DTA, so that this file can be accessed
  339. from several nodes and keep system-wide score results.  This file should be
  340. kept on a non-volatile (hard or floppy) disk.  This non-readable file contains
  341. the source data used to create the readable "SCOREBOARD" bulletin, which is
  342. placed with your other bulletins, even if on RAM disk.  If this file is
  343. deleted, Nirvana starts a new one.
  344.  
  345.  
  346. MINLEFT=n
  347.  
  348. If you don't specify a PCBoard.Sys file, this option lets you set the number of
  349. minutes for the session in the range 0 to 700.  (The default is 30 minutes.)
  350.  
  351. The program gives the warnings "Three minutes left!" and "Time is up!" and
  352. terminates, so user is returned to your BBS software.
  353.  
  354.  
  355. BIOS MODEM
  356.  
  357. This option uses BIOS calls for all modem control and I/O, instead of reading
  358. and writing directly to the serial port registers.  This was Nirvana's original
  359. (tried and true for many) modem I/O.  Let us know if you need this--we might
  360. want to remove it from future releases.
  361.  
  362.  
  363. DOS SCREEN
  364.  
  365. This makes the program do local output through DOS calls, rather than writing
  366. into screen memory.  The local status line is suppressed, so use this only if
  367. needed, such as on a multi-tasking system or to enable I/O redirection.
  368.  
  369. DOS SCREEN takes priority over /S, described in NIRVANA.DOC, which does local
  370. output through BIOS calls.
  371.  
  372.  
  373. NUL SCREEN
  374.  
  375. Multi-taskers use this to suppress local screen output (bleed through) at the
  376. start of the program.  This may be toggled by pressing F9, as described below.
  377.  
  378.  
  379. REDIRECTION OF INPUT/OUTPUT AS A METHOD OF DOOR INSTALLATION
  380.  
  381. To redirect NIRVANA's input/output to a com port by DOS redirection methods
  382. such as CTTY COM1 and the DOORWAY program, use DOS SCREEN and do not use COMn.
  383. Other config file entries are optional.  NIRVANA's special door features will
  384. not be in effect.  This version of NIRVANA and Gateway are not compatible.
  385.  
  386. For the DOORWAY program, set up a batch file such as (see DOORWAY's
  387. documentation for details):
  388.  
  389.             CD \NIRVANA
  390.             <path>\DOORWAY COM1 /B:M /G:ON /S:\PCB\ /P:NIRVANA.EXE NIRV.CFG
  391.             CD \PCB
  392.             BOARD.BAT
  393.  
  394.  
  395.  
  396. 6
  397.  
  398.  
  399. HIGH SPEED MODEM CONFIGURATION
  400.  
  401. Our users report that they have trouble using the US Robotics HST modem for
  402. Nirvana and other doors unless it is properly configured.  Try setting $Y3 to
  403. prevent the modem from clearing its internal buffer when a break is received.
  404. It might also help to set &R1 to ignore RTS.
  405.  
  406.  
  407. NOTES FOR MULTI-NODE USERS
  408.  
  409. This version of Nirvana writes data files to disk.  DOS SHARE.EXE file locking
  410. only (not record locking) is required for file sharing compatibility.  At this
  411. writing, Multi-node DOS file-level locking has been tested in a limited range
  412. of environments, including networks and multi-tasking.
  413.  
  414. Use a shared \NIRVANA directory for the SAVE file and the SCORE file by
  415. specifying something like SAVE=E:\NIRVANA and SCORE=E:\NIRVANA\SCORE.DTA in all
  416. nirv.cfg files.  The bulletin file can be shared or not.  All other files can
  417. be in local \NIRVANA directories for each node (to minimize network traffic) or
  418. in the single shared \NIRVANA directory containing a NIRVn.cfg file for each
  419. node.
  420.  
  421.  
  422. TESTING NIRV.CFG
  423.  
  424. If you use the command line NIRVANA.EXE TEST NIRV.CFG, the program will display
  425. config file entries that it recognizes, and then halt.
  426.  
  427.  
  428. SUPPORT!
  429.  
  430. If you find Nirvana and support worthwhile, please help out by mailing $20.00
  431. or what you can afford.  THANK YOU FOR YOUR SUPPORT!
  432.  
  433.  
  434. ONLINE SYSOP REGISTRATION IS EASY--CALL US!
  435.  
  436. You must register your copy of Nirvana for use on your BBS.  You may do this by
  437. postcard or online on WIMSEY GAMES BBS in Atlanta, (404) 255-8646.
  438.  
  439. Once online, registration is speedy.  Just enter the Nirvana registration door
  440. and you'll also receive a registration number without charge to enable the SAVE
  441. & RESTORE feature.  Your questions and comments are welcome.  An effort will be
  442. made to assist with or correct any problem.
  443.  
  444.      Bill White, Wimsey Co., 235 River Springs Dr. NW, Atlanta, GA 30328
  445.  
  446.  
  447. SYSOP REGISTRATION FORM for Nirvana Version 3.1
  448.  
  449. My name:   ____________________   Note:  Sysops may register online on Wimsey
  450.                                          Games BBS, (404) 255-8646 and get
  451. BBS Name:  ____________________          immediate ability to save and restore!
  452.  
  453. Address:   ________________________________________
  454.  
  455. BBS phone number: _____________  BBS/Network Software type: ____________
  456.